Discovery API - Test
Error messages
Overview of error codes
| Scenarios | HTTP Error Code | Error Type | Error Message | Applicable to |
|---|---|---|---|---|
| The system did not receive an identifier in the request. | 400 | MISSING_MANDATORY_INPUT | There were no valid property identifiers received in the request. // if validating multiple fields. There were no valid title identifiers received in the request. | property summary, title summary |
| The system did not receive an identifier in the request. | 400 | MISSING_MANDATORY_INPUT | {field name} must be provided // when validating single field | all |
| The system received multiple identifiers in the request. | 400 | TOO_MANY_IDENTIFIERS | There was more than one property identifiers received in the request. Only one property identifier is allowed | property summary |
| The system received multiple identifiers in the request. | 400 | TOO_MANY_IDENTIFIERS | There was more than one title identifier received in the request. Only one title identifier is allowed | title summary |
| The propertyPFI format/length is invalid OR The SPI format/length is invalid OR Invalid Volume and Folio format provided in the request | 400 | INVALID_INPUT | {field name} must match the pattern {regex} | all |
| Unauthorized. Invalid/ missing JWT token. Failed authentication. ‘I don’t recognise you' | 401 | all | ||
| Forbidden. No permission to access the requested resource/ API. 'I know who you are, but you're not allowed to access this resource. | 403 | all | ||
| The system failed to find a property to return in the response. | 404 | RECORD_NOT_FOUND | There were no active nor proposed properties found for the identifier received. | property summary |
| The system failed to find a parcel to return in the response. | 404 | RECORD_NOT_FOUND | There were no active nor proposed parcels found for the identifier received. | parcel summary |
| The request did not contain a valid Municipality name. | 404 | RECORD_NOT_FOUND | The Municipality Name provided was not recognised as a valid Municipality Name. | property summary |
| The request encountered an unhandled exception, e.g. unable to connect to DB | 500 | INTERNAL_SERVER_ERROR | The system has encountered an unexpected error, please try again later. | all |